add PAR script action #31188

OliviaShoup · 2025-08-20T08:18:46Z

What does this PR do? What is the motivation?

This PR adds a new page for the Private Action Runner (PAR) script action.

Merge instructions

Merge readiness:

Ready for merge

github-actions · 2025-08-20T08:19:03Z

ℹ️ Documentation Team Review

No documentation team review is required for this pull request.

github-actions · 2025-08-20T08:22:19Z

Preview links (active after the `build_preview` check completes)

New or renamed files

Modified Files

https://docs-staging.datadoghq.com/olivia.shoup/docs-11282/actions/private_actions/

content/en/actions/private_actions/run_script.md

dd-gplassard · 2025-08-20T08:51:23Z

content/en/actions/private_actions/run_script.md

+### 1. Update your runner image
+
+Replace the standard PAR image with the development image that supports script actions. The development images are published on [Docker Hub][2].
+
+**Standard image:**
+```
+gcr.io/datadoghq/private-action-runner:v1.3.0
+```
+
+**Script-enabled image:**
+```
+datadog/private-action-runner-dev:latest@sha256:4e990e496b79d02514c19a633042d27be1ba8e7a4b9018efd0e942ed1a070ad8
+```
+
+You can either reuse an existing runner's identity by changing the image, or create a brand new runner.


These are specific to the preview phase PAR Version**: 1.7.0 or later should be sufficient

content/en/actions/private_actions/run_script.md

Co-authored-by: Gabriel Plassard <[email protected]>

…ation into olivia.shoup/docs-11282

Co-authored-by: Gabriel Plassard <[email protected]>

…ation into olivia.shoup/docs-11282

Co-authored-by: Gabriel Plassard <[email protected]>

…ation into olivia.shoup/docs-11282

Co-authored-by: Gabriel Plassard <[email protected]>

merchristK · 2025-08-30T21:06:16Z

content/en/actions/private_actions/run_script.md

+To use the script action, you need:
+
+- **Custom tools**: For CLI tools not included in the base image, you need to create a custom Docker image.
+- **PAR Version**: 1.7.0 or later. See [set up a private action runner][2] to get started.


Is this dynamic ? The version is 1.7.0 but we bump it regularly

merchristK · 2025-08-30T21:08:09Z

content/en/actions/private_actions/run_script.md

+
+### 3. Configure the action catalog
+
+You can find the "Run Predefined Script" action marked as "experimental" in the action catalog. This action is available for use in both workflows and apps.


This action is not "experimental" anymore as it has been released.

merchristK · 2025-08-30T21:10:37Z

content/en/actions/private_actions/run_script.md

+    command: [ "bash", "/etc/dd-action-runner-script/scripts/script.sh" ]
+```
+
+## Updating the PAR


I think we should have a dedicated page for this section no ?

Good question! I've been thinking about this but I'm still not sure. @dd-gplassard do you have an opinion on this?

Yes agreed, I think a dedicated page would be a good thing

merchristK · 2025-08-30T21:11:10Z

content/en/actions/private_actions/run_script.md

+
+<!-- ADD INFO? -->
+
+To view the latest version of the PAR, check [this URL][6].


Is it possible that we display the latest version in the doc dynamically by fetching the response of this URL ?

content/en/actions/private_actions/run_script.md

merchristK · 2025-08-30T21:17:42Z

content/en/actions/private_actions/run_script.md

+
+To check the PAR logs: 
+```bash
+docker logs <id-of-container>


@dd-gplassard do you think it's better in the example to create the containers with --name datadog-private-actions-runner and then use that name downstream instead of <id-of-container> ?

Unfortunately I think this would be annoying because it would create conflicts when trying to rerun the command

merchristK · 2025-08-30T21:18:38Z

content/en/actions/private_actions/run_script.md

+      - "9016:9016"
+    volumes:
+      - "./config:/etc/dd-action-runner"
+    user: "0"


same here: we might need to remove this user as it would run as root

yes most up to date is

services: runner: image: gcr.io/datadoghq/private-action-runner:v1.7.0 cpus: 25 mem_limit: 1g deploy: replicas: 1 environment: - DD_BASE_URL=https://app.datadoghq.com - DD_PRIVATE_RUNNER_CONFIG_DIR=/etc/dd-action-runner/config - RUNNER_ENROLLMENT_TOKEN=<the_token> - STATSD_ENABLED=true volumes: - "./config:/etc/dd-action-runner/config"

content/en/actions/private_actions/run_script.md

merchristK · 2025-08-30T21:19:30Z

content/en/actions/private_actions/run_script.md

+### Helm mode
+When using Helm, there are two options for upgrading the PAR: 
+1. **(Recommended)** Upgrade the chart, which will use the latest version of the PAR. There may be changes to the chart; please review [our changelog][8].
+1. Upgrade the runner without upgrading the chart.


Suggested change

1. Upgrade the runner without upgrading the chart.

2. Upgrade the runner without upgrading the chart.

merchristK · 2025-08-30T21:20:47Z

content/en/actions/private_actions/run_script.md

+
+```bash
+helm repo update
+helm upgrade <RELEASE_NAME> datadog/private-action-runner -f ./values.yaml


we should say <RELEASE_NAME> is the release name they used when creating the runner. But I believe here it will make it easier if this Upgrade section is closed to the Create section so users keep stay in the same context.

dd-gplassard · 2025-09-02T16:15:05Z

content/en/actions/private_actions/run_script.md

+FROM gcr.io/datadoghq/private-action-runner:v1.7.0
+RUN apt update && apt install -y python3


Suggested change

FROM gcr.io/datadoghq/private-action-runner:v1.7.0

RUN apt update && apt install -y python3

FROM gcr.io/datadoghq/private-action-runner:v1.7.0

USER root

RUN apt update && apt install -y python3

USER dog

I thought end user is scriptuser ?

this is the default user the runner will be running as

root -> install dependencies
dog -> runs the runner (read + write permission on the runner config)
scriptuser -> the runner sus as scriptuser (no permissions on the runner config)

dd-gplassard · 2025-09-02T16:20:03Z

content/en/actions/private_actions/run_script.md

+
+Run:
+```bash
+docker run -d  -u 0 --platform=linux/x86_64  -p 9016:9016  -v ./config:/etc/dd-action-runner  --health-cmd "curl http://localhost:9016/liveness"  --health-interval 10s  --health-timeout 10s  --health-retries 3 gcr.io/datadoghq/private-action-runner:v1.0.0


yes we recently updated the flag so we should no longer use --platform and --user (and added --cpus and --memory) maybe we should put the exact command inside the app on the runner's edit page ? This way we can keep them in sync more easily ? But maybe we can start with the doc like this for now

The latest command should be

docker run -d \ --cpus="0.25" \ --memory="1g" \ -e DD_PRIVATE_RUNNER_CONFIG_DIR=/etc/dd-action-runner/config -v ./config:/etc/dd-action-runner/config \ --health-cmd "curl http://localhost:9016/liveness" \ --health-interval 10s \ --health-timeout 10s \ --health-retries 3 gcr.io/datadoghq/private-action-runner:v1.7.0

(essentially what this displays but removing all env variables except the config dir one )

dd-gplassard · 2025-09-02T16:22:35Z

content/en/actions/private_actions/run_script.md

+
+To check the PAR logs: 
+```bash
+docker logs <id-of-container>


Unfortunately I think this would be annoying because it would create conflicts when trying to rerun the command

dd-gplassard · 2025-09-02T16:24:02Z

content/en/actions/private_actions/run_script.md

+      - "9016:9016"
+    volumes:
+      - "./config:/etc/dd-action-runner"
+    user: "0"


yes most up to date is

services: runner: image: gcr.io/datadoghq/private-action-runner:v1.7.0 cpus: 25 mem_limit: 1g deploy: replicas: 1 environment: - DD_BASE_URL=https://app.datadoghq.com - DD_PRIVATE_RUNNER_CONFIG_DIR=/etc/dd-action-runner/config - RUNNER_ENROLLMENT_TOKEN=<the_token> - STATSD_ENABLED=true volumes: - "./config:/etc/dd-action-runner/config"

OliviaShoup added 3 commits July 22, 2025 16:42

Add new page

46d5763

Merge branch 'master' into olivia.shoup/docs-11282

799bacb

Add first draft

229ba7d

OliviaShoup added the under_review Sent to someone outside of the docs team for review. label Aug 20, 2025

github-actions bot added the Architecture Everything related to the Doc backend label Aug 20, 2025

dd-gplassard reviewed Aug 20, 2025

View reviewed changes

OliviaShoup and others added 17 commits August 28, 2025 13:44

Update content/en/actions/private_actions/run_script.md

9180a2c

Co-authored-by: Gabriel Plassard <[email protected]>

Cut mention of other integrations

ba333cc

Merge branch 'olivia.shoup/docs-11282' of github.com:DataDog/document…

8eccba4

…ation into olivia.shoup/docs-11282

Update content/en/actions/private_actions/run_script.md

6af09ee

Co-authored-by: Gabriel Plassard <[email protected]>

Cut redundant info in pre-requisites

ef1e22c

Merge branch 'olivia.shoup/docs-11282' of github.com:DataDog/document…

5ec9395

…ation into olivia.shoup/docs-11282

Cut bit about placeholder

d0574cf

Cut Manage Access section

4dedb25

Cut Docker configuration example (for now)

a4939b8

Update content/en/actions/private_actions/run_script.md

6e00135

Co-authored-by: Gabriel Plassard <[email protected]>

Cut Helm deployment info

457305f

Merge branch 'olivia.shoup/docs-11282' of github.com:DataDog/document…

e271f7c

…ation into olivia.shoup/docs-11282

Update content/en/actions/private_actions/run_script.md

cafbbb6

Co-authored-by: Gabriel Plassard <[email protected]>

Update content/en/actions/private_actions/run_script.md

a58396f

Co-authored-by: Gabriel Plassard <[email protected]>

Update content/en/actions/private_actions/run_script.md

f81bde3

Co-authored-by: Gabriel Plassard <[email protected]>

Merge branch 'master' into olivia.shoup/docs-11282

dc5177b

Add section for upgrading the PAR

299fbbd

merchristK reviewed Aug 30, 2025

View reviewed changes

dd-gplassard reviewed Sep 2, 2025

View reviewed changes

OliviaShoup added 3 commits September 2, 2025 16:25

Cut outdated info

8b9ff23

Update Docker Compose YAML

2eec43e

Rename runner in YAML

1430fc2

OliviaShoup added 6 commits September 2, 2025 16:31

Add YAML tag to code block

4e121e0

Make private action runner lowercase

0772796

Update heading with abbreviation

43c8754

Fix heading tense

4b5a90a

Reword + add link to Run Predefined Script in app

1510ad1

Move updating PAR to separate page

18357da


		### 3. Configure the action catalog

		You can find the "Run Predefined Script" action marked as "experimental" in the action catalog. This action is available for use in both workflows and apps.


		<!-- ADD INFO? -->

		To view the latest version of the PAR, check [this URL][6].

	1. Upgrade the runner without upgrading the chart.
	2. Upgrade the runner without upgrading the chart.

		FROM gcr.io/datadoghq/private-action-runner:v1.7.0
		RUN apt update && apt install -y python3

add PAR script action #31188

Are you sure you want to change the base?

add PAR script action #31188

Conversation

OliviaShoup commented Aug 20, 2025

What does this PR do? What is the motivation?

Merge instructions

Uh oh!

github-actions bot commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ℹ️ Documentation Team Review

Uh oh!

github-actions bot commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Preview links (active after the build_preview check completes)

New or renamed files

Modified Files

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dd-gplassard Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dd-gplassard Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Aug 20, 2025 •

edited

Loading

github-actions bot commented Aug 20, 2025 •

edited

Loading

Preview links (active after the `build_preview` check completes)

dd-gplassard Sep 4, 2025 •

edited

Loading

dd-gplassard Sep 2, 2025 •

edited

Loading